/*
 * Copyright (c) 2013, SRI International
 * All rights reserved.
 * Licensed under the The BSD 3-Clause License;
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 * 
 * http://opensource.org/licenses/BSD-3-Clause
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of the aic-web-praise nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.sri.ai.lpitools.gwtgui.client;

import java.util.ArrayList;

import com.google.gwt.core.client.GWT;
import com.google.gwt.user.client.rpc.RemoteService;
import com.google.gwt.user.client.rpc.RemoteServiceRelativePath;
import com.google.gwt.user.client.rpc.ServiceDefTarget;
import com.sri.ai.lpitools.cobra.gwtutil.dataobjects.shared.EvidenceInfo;
import com.sri.ai.lpitools.cobra.gwtutil.dataobjects.shared.LWPException;
import com.sri.ai.lpitools.cobra.gwtutil.dataobjects.shared.ModelInfo;
import com.sri.ai.lpitools.cobra.gwtutil.dataobjects.shared.QueryInfo;
import com.sri.ai.lpitools.cobra.gwtutil.dataobjects.shared.QueryOptionsGWT;
import com.sri.ai.lpitools.cobra.gwtutil.dataobjects.shared.TreeNode;
import com.sri.ai.lpitools.cobra.gwtutil.dataobjects.shared.TreeNode.TreeType;
import com.sri.ai.lpitools.cobra.gwtutil.dataobjects.shared.UserInfo;

@RemoteServiceRelativePath("RPCService")
public interface RPCService extends RemoteService {

	public static final String invalidReturnString = "Not Valid";
	
	//abstract methods that need to be implemented in the server class
	public String getModel(String user, String title) throws LWPException;
	public String getModelList(String user) throws LWPException;
	public boolean saveModel(String user, String title, ModelInfo model) throws LWPException;
	public boolean saveModelInfo(String user, String title, ModelInfo model) throws LWPException;
	public boolean saveModelBody(String user, String title, ModelInfo model) throws LWPException;
	public boolean checkModel(String model) throws LWPException;
	public String runQuery(String user, String model, String evidenceTitle, String query, QueryOptionsGWT options) throws LWPException;
	public boolean saveQuery(String user, QueryInfo query) throws LWPException;
	public boolean saveEvidence(String user, EvidenceInfo evidence) throws LWPException;
	public String getQueryList(String user) throws LWPException;
	public QueryInfo getQuery(String user, String queryTitle) throws LWPException;
	public boolean deleteModelByKey(String user, String modelName) throws LWPException;
	public boolean deleteQuery(String user, String query) throws LWPException;
	
	/**
	 * The String returned is the JSON serialization of the user or invalidReturnString
	 * @param user
	 */
	public String checkUser(String user) throws LWPException;
	public String getEvidenceList(String user) throws LWPException;
	public boolean deleteEvidence(String user, String evidenceName) throws LWPException;
	public String listUsers() throws LWPException;
	public String getID() throws LWPException;
	public ArrayList<TreeNode> getNodeChildren(String nodeID, String clientID, TreeType nodeType) throws LWPException;
	public boolean deleteUser(String userName) throws LWPException;
	public boolean saveUser(UserInfo user) throws LWPException;
	public EvidenceInfo getEvidence(String user, String evidenceTitle) throws LWPException;
	public String getLatexImage(String queryResult) throws LWPException;
	public String getHttpSession();
	public boolean checkHttpSession(String sessionID);
	public boolean setUserData(String userInfo);
	public String getUserData();
	public boolean resetSession();
	
	/**
	 * Utility class for simplifying access to the instance of async service.
	 */
	public static class Util {
		private static RPCServiceAsync instance;
		public static RPCServiceAsync getInstance(){
			if (instance == null) {
				instance = (RPCServiceAsync) GWT.create(RPCService.class);
                ServiceDefTarget target = (ServiceDefTarget) instance;
              
                target.setServiceEntryPoint(GWT.getModuleBaseURL() + "RPCService");	
			}
			return instance;
		}
	}



	

	


	
	
	
}
